时调|都会_分布式定时任务调度框架Quartz学习与实战记录完整篇

篇首语：本文由编程笔记#小编为大家整理，主要介绍了分布式定时任务调度框架Quartz学习与实战记录完整篇相关的知识，希望对你有一定的参考价值。

1.Quartz的概念

Quartz就是一个基于Java实现的任务调度框架&＃xff0c;用于执行你想要执行的任何任务。
Quartz是OpenSymphony开源组织在Job scheduling&＃xff08;定时调度&＃xff09;领域的开源项目&＃xff0c;它可以与J2EE和J2SE应用程序相结合也可以单独使用。

Quartz是开源且具有丰富特性的任务调度库&＃xff0c;能够集成任何的Java应用。它能创建简单的或者复杂的调度任务&＃xff0c;以执行上十&＃xff0c;上百&＃xff0c;上千&＃xff0c;上万的任务。任务job被定义为标准的Java组件。能工执行任何你想要实现的功能。Quartz调度框架包含许多企业级的特性&＃xff0c;如JTA事务&＃xff0c;集群的支持。

官网&＃xff1a;http://www.quartz-scheduler.org/

2.Quartz运行环境

• Quartz可以运行嵌入在另一个独立的应用程序中
• Quartz可以在应用程序服务器&＃xff08;或servlet容器&＃xff09;内被实例化&＃xff0c;bin参与事务
• Quartz可以作为一个独立的程序运行&＃xff08;其自己的java虚拟机内&＃xff09;&＃xff0c;可以通过RMI使用
• Quartz可以被实例化&＃xff0c;作为独立的项目集群&＃xff08;负载平衡和故障转移功能&＃xff09;&＃xff0c;用于作业执行

3.Quartz使用的设计模式

• Builder模式
• Factory模式
• 组件模式
• 链式编程

4.Quartz学习的核心概念

• 任务Job

job就是你想实现的任务类&＃xff0c;每一个job必须实现org.quartz.job接口&＃xff0c;且只需实现接口定义的execute()方法

• 触发器Trigger

Trigger为你执行任务的触发器&＃xff08;定时&＃xff09;
Trigger主要包含两个SimpleTrigger和CronTrigger两种

• 调度器Scheduler

Scheduler为定时任务调度&＃xff0c;它会将任务Job及触发器Trigger整合起来&＃xff0c;负责基于Trigger设定的时间来执行Job

5.Quartz的体系结构

6.Quartz的几个常用API

• Scheduler&＃xff1a;用于定时调度程序交互的主程序接口。Scheduler调度程序&＃xff1a;任务执行计划表&＃xff0c;只有安排进执行计划的任务Job【通过scheduler.scheduleJob方法安排进执行任务】&＃xff0c;当它预先定义的执行时间到了的时候&＃xff08;任务出发trigger&＃xff09;该任务才会被执行

• Job&＃xff1a;预先定义的&＃xff0c;希望在未来某个使劲能被调度程序执行的任务类&＃xff0c;可自定义

• JobDetail&＃xff1a;使用JobDetail来定义定时任务的实例&＃xff0c;JobDetail实例是通过JobBuilder类创建的

• JobDataMap&＃xff1a;可以包含不限量&＃xff08;序列化的&＃xff09;的数对象&＃xff0c;在Job实例执行的时候&＃xff0c;可以使用其中的数据&＃xff1b;JobDataMap是Java Map接口的一个实现&＃xff0c;额外增加了一些便于存取基本类型数据的方法

• Trigger&＃xff1a;触发器&＃xff0c;Trigger对象是用来触发执行Job的。当调度一个Job时&＃xff0c;我们实例一个触发器然后调整他的属性来满足Job执行的条件。表明任务在什么时候会执行。【定义了一个已经被安排的任务将会在什么时候执行的时间条件】

• JobBuilder&＃xff1a;用于声明一个任务实例&＃xff0c;也可以定义关于该任务的详情比如任务名&＃xff0c;组名等。通过JobBuilder声明的实例将会作为一个实际执行的任务。

• TriggerBuilder&＃xff1a;触发器创建器&＃xff0c;用于创建触发器trigger实例

• JobListener、TriggerListener、SchedulerListener监听器&＃xff0c;用于对组件的监听

7.入门案例

构建一个任务类实现Job接口&＃xff0c;重写execute&＃xff08;执行方法&＃xff09;方法&＃xff0c;在执行方法中编写定时调度需要实现的逻辑。
创建一个main方法&＃xff0c;在main方法中构建任务实例和处方实例有调度器实例进行绑定并开启任务。

7.1.pom.xml

<dependency>
<groupId>org.quartz-schedulergroupId>
<artifactId>quartzartifactId>
<version>2.3.0version>
dependency>
<dependency>
<groupId>org.quartz-schedulergroupId>
<artifactId>quartz-jobsartifactId>
<version>2.3.0version>
dependency>
<dependency>
<groupId>org.projectlombokgroupId>
<artifactId>lombokartifactId>
dependency>


7.2.任务类

/**
* &＃64;Author ScholarTang
* &＃64;Date 2021/7/13 10:45
* &＃64;Desc 任务类
*/
&＃64;Slf4j
public class HelloJob implements Job
&＃64;Override
public void execute(JobExecutionContext jobExecutionContext) throws JobExecutionException
log.info(new SimpleDateFormat("yyyy-MM-dd hh:mm:ss").format(new Date()) &＃43; " | 任务被执行了");




7.3.调度器

/**
* &＃64;Author ScholarTang
* &＃64;Date 2021/7/13 10:53
* &＃64;Desc 调度器
*/
public class HelloSchedulerDemo
public static void main(String[] args) throws SchedulerException
//从调度工厂中获取调度器实例
Scheduler scheduler &＃61; StdSchedulerFactory.getDefaultScheduler();
//通过JobBuilder构建一个任务实例
JobDetail jobDetail &＃61; JobBuilder.newJob(HelloJob.class)
//设置任务的唯一实例名称和任务组名称组名
.withIdentity("job1", "group1")
//构建实例
.build();
//通过TriggerBuilder构建触发器实例
SimpleTrigger trigger &＃61; TriggerBuilder.newTrigger()
//设置触发器唯一实例名称和触发器的组名
.withIdentity("trigger1", "group1")
//执行计划&＃xff0c;每五秒执行一次
.withSchedule(SimpleScheduleBuilder.repeatSecondlyForever(5))
//立即执行
.startNow()
//构建实例
.build();
//调度器绑定任务实例和触发器
scheduler.scheduleJob(jobDetail,trigger);
//开启定时任务
scheduler.start();




7.4.执行结果

8.Job和JobDetail的关系介绍

• Job&＃xff1a;工作任务调度接口&＃xff0c;任务类需要实现的接口。该接口中定义了execute方法&＃xff0c;类似JDK提供的TimeTask类的run方法。在这里面编写任务执行的业务逻辑
• Job实例在Quartz中的生命周期&＃xff1a;每次调度器执行Job时&＃xff0c;它在调用execute方法前会创建一个新的Job实例&＃xff0c;当调度完成后&＃xff0c;管理的Job对象实例将会被释放&＃xff0c;释放的实例会被垃圾回收机制回收

&＃64;Slf4j
public class HelloJob implements Job
public HelloJob()
log.info("实例被创建了");

&＃64;Override
public void execute(JobExecutionContext jobExecutionContext) throws JobExecutionException
log.info(new SimpleDateFormat("yyyy-MM-dd hh:mm:ss").format(new Date()) &＃43; " | 任务被执行了");




• JobDetail&＃xff1a;JobDetail为Job实例提供了许多设置属性&＃xff0c;已经JobDetaMap成员变量属性&＃xff0c;它用来存储特定Job实例的状态信息&＃xff0c;调度器需要借助于JobDetail对象来添加Job实例【JobDetail中重要的属性&＃xff1a;name[任务实例的唯一标识名称]、group[任务调度实例的组名]、jobClass[任务类信息]、jobDataMap】

&＃64;Slf4j
public class HelloSchedulerDemo
public static void main(String[] args) throws SchedulerException
//从调度工厂中获取调度器实例
Scheduler scheduler &＃61; StdSchedulerFactory.getDefaultScheduler();
//通过JobBuilder构建一个任务实例
JobDetail jobDetail &＃61; JobBuilder.newJob(HelloJob.class)
//设置任务的唯一实例名称和任务组名称组名
.withIdentity("job1", "group1")
//构建实例
.build();
//jobDataMap
JobDataMap jobDataMap &＃61; jobDetail.getJobDataMap();
//任务实例的唯一标识名称
String name &＃61; jobDetail.getKey().getName();
//任务调度实例的组名
String group &＃61; jobDetail.getKey().getGroup();
//任务类信息
String clazzName &＃61; jobDetail.getKey().getClass().getName();
log.info("jobDataMap:", jobDataMap);
log.info("任务实例的唯一标识名称&＃xff1a;"&＃43;name);
log.info("任务调度实例的组名&＃xff1a;"&＃43;group);
log.info("任务类信息&＃xff1a;"&＃43;clazzName);
//通过TriggerBuilder构建触发器实例
SimpleTrigger trigger &＃61; TriggerBuilder.newTrigger()
//设置触发器唯一实例名称和触发器的组名
.withIdentity("trigger1", "group1")
//执行计划&＃xff0c;每五秒执行一次
.withSchedule(SimpleScheduleBuilder.repeatSecondlyForever(5))
//立即执行
.startNow()
//构建实例
.build();
//调度器绑定任务实例和触发器
scheduler.scheduleJob(jobDetail,trigger);
//开启定时任务
scheduler.start();




9.JobExecutionContext的介绍

• 当Scheduler调用一个Job&＃xff0c;就会将JobExecutionContext传递给Job的execute()方法

• Job能通过JobExecuteContext对象访问到Quartz运行时的环境以及Job本身的明细数据

  
  
  • 获取JobDetail相关信息、获取Trigger相关信息、获取Job类本身的信息

  /**
* &＃64;Author ScholarTang
* &＃64;Date 2021/7/13 10:45
* &＃64;Desc 任务类
*/
&＃64;Slf4j
public class HelloJob implements Job
&＃64;Override
public void execute(JobExecutionContext jobExecutionContext) throws JobExecutionException
//通过JobExecutionContext获取JobDetail
JobDetail jobDetail &＃61; jobExecutionContext.getJobDetail();
JobKey jobKey &＃61; jobDetail.getKey();
String jobDetailName &＃61; jobKey.getName();
String jobDetailGroup &＃61; jobKey.getGroup();
String jobClazzNameJobDetail &＃61; jobKey.getClass().getName();
log.info("任务实例的唯一标识名称&＃xff1a;" &＃43; jobDetailName);
log.info("任务实例的组名&＃xff1a;" &＃43; jobDetailGroup);
log.info("任务实例绑定的任务类信息&＃xff1a;" &＃43; jobClazzNameJobDetail);
log.info("-----------------------------------------");
//通过JobExecutionContext获取Trigger
Trigger trigger &＃61; jobExecutionContext.getTrigger();
TriggerKey triggerKey &＃61; trigger.getKey();
String triggerKeyName &＃61; triggerKey.getName();
String triggerKeyGroup &＃61; triggerKey.getGroup();
String triggerClazzName &＃61; triggerKey.getClass().getName();
log.info("触发器的唯一标识名称&＃xff1a;" &＃43; triggerKeyName);
log.info("触发器的组名&＃xff1a;" &＃43; triggerKeyGroup);
log.info("触发器绑定的任务类信息&＃xff1a;" &＃43; triggerClazzName);
log.info("-----------------------------------------");
//通过JobExecutionContext
String jobClazzName &＃61; jobExecutionContext.getClass().getName();
log.info("job类相关的信息&＃xff1a;"&＃43;jobClazzName);
log.info("-----------------------------------------");
log.info(new SimpleDateFormat("yyyy-MM-dd hh:mm:ss").format(new Date()) &＃43; " | 任务被执行了");




10.JobDataMap介绍

10.1.使用Map获取

• 在进行任务调度时&＃xff0c;JobDataMap存储在JobExecutionContent中&＃xff0c;非常方便获取
• JobDataMap可以用来存储任何可序列化的数据对象&＃xff0c;当Job实例对象被执行时这些参数都会传递给它
• JobDataMap实现了JDK的Map接口&＃xff0c;并且添加了非常方便的方法来存储基本数据类型

/**
* &＃64;Author ScholarTang
* &＃64;Date 2021/7/13 10:53
* &＃64;Desc 调度器
*/
&＃64;Slf4j
public class HelloSchedulerDemo
public static void main(String[] args) throws SchedulerException
//从调度工厂中获取调度器实例
Scheduler scheduler &＃61; StdSchedulerFactory.getDefaultScheduler();
//通过JobBuilder构建一个任务实例
JobDetail jobDetail &＃61; JobBuilder.newJob(HelloJob.class)
//设置任务的唯一实例名称和任务组名称组名
.withIdentity("job1", "group1")
//设置jobDataMap数据 <<&＃61;&＃61;&＃61;&＃61;&＃61;&＃61;&＃61;&＃61;&＃61;&＃61;&＃61;&＃61;&＃61;&＃61;&＃61;
.usingJobData("message","勇敢牛牛、不怕困难")
//构建实例
.build();
//通过TriggerBuilder构建触发器实例
SimpleTrigger trigger &＃61; TriggerBuilder.newTrigger()
//设置触发器唯一实例名称和触发器的组名
.withIdentity("trigger1", "group1")
//设置jobDataMap数据 <<&＃61;&＃61;&＃61;&＃61;&＃61;&＃61;&＃61;&＃61;&＃61;&＃61;&＃61;&＃61;&＃61;&＃61;&＃61;
.usingJobData("username","张三")
//执行计划&＃xff0c;每五秒执行一次
.withSchedule(SimpleScheduleBuilder.repeatSecondlyForever(5))
//立即执行
.startNow()
//构建实例
.build();
//调度器绑定任务实例和触发器
scheduler.scheduleJob(jobDetail,trigger);
//开启定时任务
scheduler.start();




/**
* &＃64;Author ScholarTang
* &＃64;Date 2021/7/13 10:45
* &＃64;Desc 任务类
*/
&＃64;Slf4j
public class HelloJob implements Job
&＃64;Override
public void execute(JobExecutionContext jobExecutionContext) throws JobExecutionException
//通过JobExecutionContext获取JobDetail
JobDetail jobDetail &＃61; jobExecutionContext.getJobDetail();
JobKey jobKey &＃61; jobDetail.getKey();
String jobDetailName &＃61; jobKey.getName();
String jobDetailGroup &＃61; jobKey.getGroup();
String jobClazzNameJobDetail &＃61; jobKey.getClass().getName();
log.info("任务实例的唯一标识名称&＃xff1a;" &＃43; jobDetailName);
log.info("任务实例的组名&＃xff1a;" &＃43; jobDetailGroup);
log.info("任务实例绑定的任务类信息&＃xff1a;" &＃43; jobClazzNameJobDetail);
log.info("-----------------------------------------");
//通过JobExecutionContext获取Trigger
Trigger trigger &＃61; jobExecutionContext.getTrigger();
TriggerKey triggerKey &＃61; trigger.getKey();
String triggerKeyName &＃61; triggerKey.getName();
String triggerKeyGroup &＃61; triggerKey.getGroup();
String triggerClazzName &＃61; triggerKey.getClass().getName();
log.info("触发器的唯一标识名称&＃xff1a;" &＃43; triggerKeyName);
log.info("触发器的组名&＃xff1a;" &＃43; triggerKeyGroup);
log.info("触发器绑定的任务类信息&＃xff1a;" &＃43; triggerClazzName);
log.info("-----------------------------------------");
//通过JobExecutionContext
String jobClazzName &＃61; jobExecutionContext.getClass().getName();
log.info("job类相关的信息&＃xff1a;"&＃43;jobClazzName);
log.info("-----------------------------------------");
//获取JobDetail中JobDataMap中的message内容 <<&＃61;&＃61;&＃61;&＃61;&＃61;&＃61;&＃61;&＃61;&＃61;&＃61;&＃61;&＃61;&＃61;&＃61;&＃61;
JobDataMap jobDataMap &＃61; jobDetail.getJobDataMap();
String message &＃61; jobDataMap.getString("message");
log.info("从JobDetail-JobDataMap中或到的message内容为&＃xff1a;" &＃43; message);
//获取Trigger中JobDataMap中的username内容 <<&＃61;&＃61;&＃61;&＃61;&＃61;&＃61;&＃61;&＃61;&＃61;&＃61;&＃61;&＃61;&＃61;&＃61;&＃61;
JobDataMap triggerJobDataMap &＃61; trigger.getJobDataMap();
String username &＃61; triggerJobDataMap.getString("username");
log.info("从Trigger-JobDataMap中获取到的username内容为&＃xff1a;" &＃43; username);
log.info("-----------------------------------------");
log.info(new SimpleDateFormat("yyyy-MM-dd hh:mm:ss").format(new Date()) &＃43; " | 任务被执行了");




10.2.Job实现类中添加setter方法对应JobDataMap的键值&＃xff0c;Quartz框架默认的JobFactory实现类在初始化Job实例对象时会自动的调用这些setter方法

调度器的内容是不变的。
注意&＃xff1a;如果任务实例和触发器的JobDataMap中使用的是同一个key那么触发器的JobDataMap值会覆盖掉任务实例的值

/**
* &＃64;Author ScholarTang
* &＃64;Date 2021/7/13 10:45
* &＃64;Desc 任务类
*/
&＃64;Slf4j
public class HelloJob implements Job
private String message;
private String username;
public void setMessage(String message)
this.message &＃61; message;

public void setUsername(String username)
this.username &＃61; username;

&＃64;Override
public void execute(JobExecutionContext jobExecutionContext) throws JobExecutionException
//通过JobExecutionContext获取JobDetail
JobDetail jobDetail &＃61; jobExecutionContext.getJobDetail();
JobKey jobKey &＃61; jobDetail.getKey();
String jobDetailName &＃61; jobKey.getName();
String jobDetailGroup &＃61; jobKey.getGroup();
String jobClazzNameJobDetail &＃61; jobKey.getClass().getName();
log.info("任务实例的唯一标识名称&＃xff1a;" &＃43; jobDetailName);
log.info("任务实例的组名&＃xff1a;" &＃43; jobDetailGroup);
log.info("任务实例绑定的任务类信息&＃xff1a;" &＃43; jobClazzNameJobDetail);
log.info("-----------------------------------------");
//通过JobExecutionContext获取Trigger
Trigger trigger &＃61; jobExecutionContext.getTrigger();
TriggerKey triggerKey &＃61; trigger.getKey();
String triggerKeyName &＃61; triggerKey.getName();
String triggerKeyGroup &＃61; triggerKey.getGroup();
String triggerClazzName &＃61; triggerKey.getClass().getName();
log.info("触发器的唯一标识名称&＃xff1a;" &＃43; triggerKeyName);
log.info("触发器的组名&＃xff1a;" &＃43; triggerKeyGroup);
log.info("触发器绑定的任务类信息&＃xff1a;" &＃43; triggerClazzName);
log.info("-----------------------------------------");
//通过JobExecutionContext
String jobClazzName &＃61; jobExecutionContext.getClass().getName();
log.info("job类相关的信息&＃xff1a;"&＃43;jobClazzName)